<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_40) on Sun Feb 14 21:38:39 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FilterLibrary (gephi 0.9.1 API)</title>
<meta name="date" content="2016-02-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="FilterLibrary (gephi 0.9.1 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FilterLibrary.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/filters/api/FilterController.html" title="interface in org.gephi.filters.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/gephi/filters/api/FilterModel.html" title="interface in org.gephi.filters.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/filters/api/FilterLibrary.html" target="_top">Frames</a></li>
<li><a href="FilterLibrary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.filters.api</div>
<h2 title="Interface FilterLibrary" class="title">Interface FilterLibrary</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.openide.util.Lookup.Provider</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FilterLibrary</span>
extends org.openide.util.Lookup.Provider</pre>
<div class="block">The Filter Library is the place where filter builders are registered and
 ready to be used. It also has default <b>Categories</b> that filters use to
 be sorted and well-described.
 <p>
 Modules can dynamically create new filter builders and serve it ot users by
 using <a href="../../../../org/gephi/filters/api/FilterLibrary.html#addBuilder-org.gephi.filters.spi.FilterBuilder-"><code>addBuilder(org.gephi.filters.spi.FilterBuilder)</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mathieu Bastian</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/gephi/filters/spi/Category.html" title="class in org.gephi.filters.spi">Category</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#ATTRIBUTES">ATTRIBUTES</a></span></code>
<div class="block">Default <code>Category</code> for attributes filters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/gephi/filters/spi/Category.html" title="class in org.gephi.filters.spi">Category</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#EDGE">EDGE</a></span></code>
<div class="block">Default <code>Category</code> for filters working on edges only.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/gephi/filters/spi/Category.html" title="class in org.gephi.filters.spi">Category</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#TOPOLOGY">TOPOLOGY</a></span></code>
<div class="block">Default <code>Category</code> for topological filters.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#addBuilder-org.gephi.filters.spi.FilterBuilder-">addBuilder</a></span>(<a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a>&nbsp;builder)</code>
<div class="block">Adds <code>builder</code> to this library.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#deleteQuery-org.gephi.filters.api.Query-">deleteQuery</a></span>(<a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>&nbsp;query)</code>
<div class="block">Delete a saved <code>query</code> from the library.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#getBuilder-org.gephi.filters.spi.Filter-">getBuilder</a></span>(<a href="../../../../org/gephi/filters/spi/Filter.html" title="interface in org.gephi.filters.spi">Filter</a>&nbsp;filter)</code>
<div class="block">Returns the builder that has created <code>filter</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.openide.util.Lookup</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#getLookup--">getLookup</a></span>()</code>
<div class="block">Returns this library's lookup.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#registerMask-org.gephi.filters.spi.FilterLibraryMask-">registerMask</a></span>(<a href="../../../../org/gephi/filters/spi/FilterLibraryMask.html" title="interface in org.gephi.filters.spi">FilterLibraryMask</a>&nbsp;mask)</code>
<div class="block">Registers <code>mask</code> as a new <code>FilterLibraryMask</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#removeBuilder-org.gephi.filters.spi.FilterBuilder-">removeBuilder</a></span>(<a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a>&nbsp;builder)</code>
<div class="block">Removes <code>builder</code> from this library.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#saveQuery-org.gephi.filters.api.Query-">saveQuery</a></span>(<a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>&nbsp;query)</code>
<div class="block">Save <code>query</code> in the library in order it can be reused.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/FilterLibrary.html#unregisterMask-org.gephi.filters.spi.FilterLibraryMask-">unregisterMask</a></span>(<a href="../../../../org/gephi/filters/spi/FilterLibraryMask.html" title="interface in org.gephi.filters.spi">FilterLibraryMask</a>&nbsp;mask)</code>
<div class="block">Unregisters <code>mask</code> in the library.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="TOPOLOGY">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TOPOLOGY</h4>
<pre>static final&nbsp;<a href="../../../../org/gephi/filters/spi/Category.html" title="class in org.gephi.filters.spi">Category</a> TOPOLOGY</pre>
<div class="block">Default <code>Category</code> for topological filters. Use this category
 for filters working on graph topology, i.e. the structure of nodes and
 edges.</div>
</li>
</ul>
<a name="ATTRIBUTES">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTES</h4>
<pre>static final&nbsp;<a href="../../../../org/gephi/filters/spi/Category.html" title="class in org.gephi.filters.spi">Category</a> ATTRIBUTES</pre>
<div class="block">Default <code>Category</code> for attributes filters. Use this category
 for filters working on attribute values.</div>
</li>
</ul>
<a name="EDGE">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EDGE</h4>
<pre>static final&nbsp;<a href="../../../../org/gephi/filters/spi/Category.html" title="class in org.gephi.filters.spi">Category</a> EDGE</pre>
<div class="block">Default <code>Category</code> for filters working on edges only.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="addBuilder-org.gephi.filters.spi.FilterBuilder-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBuilder</h4>
<pre>void&nbsp;addBuilder(<a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a>&nbsp;builder)</pre>
<div class="block">Adds <code>builder</code> to this library.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - the builder that is to be added</dd>
</dl>
</li>
</ul>
<a name="removeBuilder-org.gephi.filters.spi.FilterBuilder-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeBuilder</h4>
<pre>void&nbsp;removeBuilder(<a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a>&nbsp;builder)</pre>
<div class="block">Removes <code>builder</code> from this library.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - the builder that is to be removed</dd>
</dl>
</li>
</ul>
<a name="getLookup--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLookup</h4>
<pre>org.openide.util.Lookup&nbsp;getLookup()</pre>
<div class="block">Returns this library's lookup. The lookup is a general container for
 objects and contains:
 <ul><li><a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi"><code>FilterBuilder</code></a>: Builders, these are building filters.</li>
 <li><a href="../../../../org/gephi/filters/spi/CategoryBuilder.html" title="interface in org.gephi.filters.spi"><code>CategoryBuilder</code></a>: Category builders, these are building.
 categories, i.e. filters containers.</li>
 <li><a href="../../../../org/gephi/filters/spi/FilterLibraryMask.html" title="interface in org.gephi.filters.spi"><code>FilterLibraryMask</code></a>: Masks, for enable/disable categories
 according to the context.</li>
 <li><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api"><code>Query</code></a>: Saved queries, look at <code>FilterController</code>
 for active queries.</li></ul>
 The lists of all <code>FilterBuilder</code> in the library can be
 obtained by doing the following command:
 <pre>
 FilterLibrary.getLookup().lookupAll(FilterBuilder.class);
 </pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getLookup</code>&nbsp;in interface&nbsp;<code>org.openide.util.Lookup.Provider</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lookup container of this library</dd>
</dl>
</li>
</ul>
<a name="registerMask-org.gephi.filters.spi.FilterLibraryMask-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerMask</h4>
<pre>void&nbsp;registerMask(<a href="../../../../org/gephi/filters/spi/FilterLibraryMask.html" title="interface in org.gephi.filters.spi">FilterLibraryMask</a>&nbsp;mask)</pre>
<div class="block">Registers <code>mask</code> as a new <code>FilterLibraryMask</code>. Such
 masks have categories enable/disable flag. Useful to disable for instance
 filters for undirected graphs when the current graph is directed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mask</code> - the mask that is to be registered</dd>
</dl>
</li>
</ul>
<a name="unregisterMask-org.gephi.filters.spi.FilterLibraryMask-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregisterMask</h4>
<pre>void&nbsp;unregisterMask(<a href="../../../../org/gephi/filters/spi/FilterLibraryMask.html" title="interface in org.gephi.filters.spi">FilterLibraryMask</a>&nbsp;mask)</pre>
<div class="block">Unregisters <code>mask</code> in the library. The mask will no longer be
 used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mask</code> - the mask that is to be unregistered</dd>
</dl>
</li>
</ul>
<a name="getBuilder-org.gephi.filters.spi.Filter-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuilder</h4>
<pre><a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a>&nbsp;getBuilder(<a href="../../../../org/gephi/filters/spi/Filter.html" title="interface in org.gephi.filters.spi">Filter</a>&nbsp;filter)</pre>
<div class="block">Returns the builder that has created <code>filter</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - the filter that the builder is to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder that has created <code>filter</code></dd>
</dl>
</li>
</ul>
<a name="saveQuery-org.gephi.filters.api.Query-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveQuery</h4>
<pre>void&nbsp;saveQuery(<a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>&nbsp;query)</pre>
<div class="block">Save <code>query</code> in the library in order it can be reused. Saved
 queries are saved to the project.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - the query that is to be saved</dd>
</dl>
</li>
</ul>
<a name="deleteQuery-org.gephi.filters.api.Query-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deleteQuery</h4>
<pre>void&nbsp;deleteQuery(<a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>&nbsp;query)</pre>
<div class="block">Delete a saved <code>query</code> from the library. Deleted queries are
 deleted from the project.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - the query that is to be deleted</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FilterLibrary.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/filters/api/FilterController.html" title="interface in org.gephi.filters.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/gephi/filters/api/FilterModel.html" title="interface in org.gephi.filters.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/filters/api/FilterLibrary.html" target="_top">Frames</a></li>
<li><a href="FilterLibrary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2016 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All rights reserved.</small></p>
</body>
</html>
